[beta] Get a Function.

Retrieve the current state of an existing Function, including its configuration, code package status, and a lastUpdateTimestampMs value for use in subsequent PATCH requests.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Read Functions under the Functions category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /functions/{name}

[beta] Get a Function.

cURL

curl --request GET \
  --url https://api.samsara.com/functions/{name} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "codePackage": {
      "status": "deployed",
      "downloadGetUrl": "https://example.com/download?token=..."
    },
    "config": {
      "handler": "index.handler",
      "isScheduleEnabled": false,
      "params": {
        "Architecto sed delectus alias molestiae iure.": "Ut dolorem.",
        "Doloribus maiores et inventore neque nemo voluptatem.": "Nemo et delectus ab est."
      },
      "secrets": {
        "Qui aut voluptas.": "Et quia corrupti deserunt molestiae est."
      },
      "schedule": {
        "entries": [
          {
            "daysOfWeek": [
              false,
              true,
              true,
              true,
              true,
              true,
              false
            ],
            "timeSinceMidnightMs": 32400000
          }
        ],
        "timezone": "America/Los_Angeles"
      }
    },
    "createdAtTime": "2021-01-01T00:00:00Z",
    "effects": {
      "nextScheduledAtTime": "2021-01-01T00:00:00Z"
    },
    "lastUpdateTimestampMs": 1609459200000,
    "name": "my-function",
    "updatedAtTime": "2021-01-01T00:00:00Z",
    "description": "Processes incoming telemetry data."
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

The name of the Function to retrieve.

Response

200

application/json

OK response.

data · object · required

Details of a Function.

Show child attributes